Add log buffering docs #46232
Open
Add log buffering docs #46232
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/log_buffering_doc
branch
5 times, most recently
from
1ad5e4b to
b8fb0b7
Compare
evgenyfedorov2
force-pushed
the
users/evgenyfedorov2/log_buffering_doc
branch
from
b8fb0b7 to
5cbf2fc
Compare
Rageking8
reviewed
May 18, 2025
Co-authored-by: Rageking8 <[email protected]>
Co-authored-by: Rageking8 <[email protected]>
Co-authored-by: Rageking8 <[email protected]>
|
@IEvangelist @gewarren may I get it reviewed, please? Thanks! |
evgenyfedorov2
requested review from
gewarren and
Rageking8
and removed request for
Rageking8
gewarren
approved these changes
May 23, 2025
Comment on lines
366
to
+368
| - name: Log Sampling | ||
| href: ../../core/extensions/log-sampling.md | ||
| - name: Log Buffering |
There was a problem hiding this comment.
Suggested change
| - name: Log Sampling | |
| href: ../../core/extensions/log-sampling.md | |
| - name: Log Buffering | |
| - name: Log sampling | |
| href: ../../core/extensions/log-sampling.md | |
| - name: Log buffering |
Comment on lines
1099
to
+1101
| - name: Log Sampling | ||
| href: ../core/extensions/log-sampling.md | ||
| - name: Log Buffering |
There was a problem hiding this comment.
Suggested change
| - name: Log Sampling | |
| href: ../core/extensions/log-sampling.md | |
| - name: Log Buffering | |
| - name: Log sampling | |
| href: ../core/extensions/log-sampling.md | |
| - name: Log buffering |
|
|
||
| Buffered logs are stored in temporary circular buffers in process memory, and the following conditions apply: | ||
|
|
||
| - If the buffer is full, the oldest logs will be dropped and never emitted. |
There was a problem hiding this comment.
Suggested change
| - If the buffer is full, the oldest logs will be dropped and never emitted. | |
| - If the buffer is full, the oldest logs are dropped and never emitted. |
| Buffered logs are stored in temporary circular buffers in process memory, and the following conditions apply: | ||
|
|
||
| - If the buffer is full, the oldest logs will be dropped and never emitted. | ||
| - If you want to emit the buffered logs, you can call `Flush()` on the `GlobalLogBuffer` or `PerRequestLogBuffer` class. |
There was a problem hiding this comment.
Suggested change
| - If you want to emit the buffered logs, you can call `Flush()` on the `GlobalLogBuffer` or `PerRequestLogBuffer` class. | |
| - If you want to emit the buffered logs, you can call <xref:Microsoft.Extensions.Diagnostics.Buffering.LogBuffer.Flush> on the <xref:Microsoft.Extensions.Diagnostics.Buffering.GlobalLogBuffer> or <xref:Microsoft.Extensions.Diagnostics.Buffering.PerRequestLogBuffer> class. |
| There are two buffering strategies available: | ||
|
|
||
| - Global buffering: Buffers logs across the entire application. | ||
| - Per-request buffering: Buffers logs for each individual HTTP request if available, otherwise - buffers to the global buffer. |
There was a problem hiding this comment.
Suggested change
| - Per-request buffering: Buffers logs for each individual HTTP request if available, otherwise - buffers to the global buffer. | |
| - Per-request buffering: Buffers logs for each individual HTTP request if available; otherwise, buffers to the global buffer. |
|
|
||
| Log buffering offers a trade-off between memory usage and log storage costs. Buffering logs in memory allows you to: | ||
|
|
||
| 1. Selectively emit logs based on runtime conditions. |
There was a problem hiding this comment.
Suggested change
| 1. Selectively emit logs based on runtime conditions. | |
| 1. Selectively emit logs based on run-time conditions. |
| - Set appropriate buffer size limits based on your application's memory constraints. | ||
| - Use per-request buffering for web applications to isolate logs by request. | ||
| - Configure auto-flush duration carefully to balance memory usage and log availability. | ||
| - Implement explicit flush triggers for important events (errors, warnings, etc.). |
There was a problem hiding this comment.
Suggested change
| - Implement explicit flush triggers for important events (errors, warnings, etc.). | |
| - Implement explicit flush triggers for important events (such as errors and warnings). |
|
|
||
| - Log buffering is not supported in .NET 8 and earlier versions. | ||
| - The order of logs is not guaranteed to be preserved. However, original timestamps are preserved. | ||
| - Custom configuration per each logging provider is not supported. Same configuration is used for all providers. |
There was a problem hiding this comment.
Suggested change
| - Custom configuration per each logging provider is not supported. Same configuration is used for all providers. | |
| - Custom configuration per each logging provider is not supported. The same configuration is used for all providers. |
| - The order of logs is not guaranteed to be preserved. However, original timestamps are preserved. | ||
| - Custom configuration per each logging provider is not supported. Same configuration is used for all providers. | ||
| - Log scopes are not supported. This means that if you use the <xref:Microsoft.Extensions.Logging.ILogger.BeginScope%2A> method, the buffered log records will not be associated with the scope. | ||
| - Not all information of the original log record is preserved. Log buffering internally uses <xref:Microsoft.Extensions.Logging.Abstractions.BufferedLogRecord> class when flushing, and its following properties are always empty: |
There was a problem hiding this comment.
Suggested change
| - Not all information of the original log record is preserved. Log buffering internally uses <xref:Microsoft.Extensions.Logging.Abstractions.BufferedLogRecord> class when flushing, and its following properties are always empty: | |
| - Not all information of the original log record is preserved. Log buffering internally uses <xref:Microsoft.Extensions.Logging.Abstractions.BufferedLogRecord> class when flushing, and the following of its properties are always empty: |
|
|
||
| ## See also | ||
|
|
||
| - [Log Sampling](log-sampling.md) |
There was a problem hiding this comment.
Suggested change
| - [Log Sampling](log-sampling.md) | |
| - [Log sampling](log-sampling.md) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes #46231
Internal previews